home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmInstallImage.z / XmInstallImage
Encoding:
Text File  |  2002-10-03  |  5.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee - A pixmap caching function that adds an
  10.           image to the image cache
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           BBBBoooooooolllleeeeaaaannnn XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee(
  15.           XXXXIIIImmmmaaaaggggeeee **** iiiimmmmaaaaggggeeee,
  16.           cccchhhhaaaarrrr **** iiiimmmmaaaaggggeeee____nnnnaaaammmmeeee);
  17.  
  18.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  19.           This page documents Motif 2.1.
  20.  
  21.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.           XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee stores an image in an image cache that can
  23.           later be used to generate a pixmap.  Part of the
  24.           installation process is to extend the resource converter
  25.           used to reference these images. The resource converter is
  26.           given the image name so that the image can be referenced in
  27.           a ....XXXXddddeeeeffffaaaauuuullllttttssss file.  Since an image can be referenced by a
  28.           widget through its pixmap resources, it is up to the
  29.           application to ensure that the image is installed before the
  30.           widget is created.
  31.  
  32.           _i_m_a_g_e     Points to the image structure to be installed.
  33.                     The installation process does not make a local
  34.                     copy of the image. Therefore, the application
  35.                     should not destroy the image until it is
  36.                     uninstalled from the caching functions.
  37.  
  38.           _i_m_a_g_e__n_a_m_e
  39.                     Specifies a string that the application uses to
  40.                     name the image. After installation, this name can
  41.                     be used in ....XXXXddddeeeeffffaaaauuuullllttttssss for referencing the image. A
  42.                     local copy of the name is created by the image
  43.                     caching functions.
  44.  
  45.           The image caching functions provide a set of eight
  46.           preinstalled images.  These names can be used within a
  47.           ....XXXXddddeeeeffffaaaauuuullllttttssss file for generating pixmaps for the resource for
  48.           which they are provided.
  49.           IIIImmmmaaaaggggeeee NNNNaaaammmmeeee       DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  50.           background       A tile of solid background
  51.           25_foreground    A tile of 25% foreground,
  52.                            75% background
  53.           50_foreground    A tile of 50% foreground,
  54.                            50% background
  55.           75_foreground    A tile of 75% foreground,
  56.                            25% background
  57.           horizontal       A tile of horizontal lines
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmIIIInnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                            of the two colors
  75.      vertical         A tile of vertical lines
  76.                       of the two colors
  77.      slant_right      A tile of slanting lines
  78.                       of the two colors
  79.      slant_left       A tile of slanting lines
  80.                       of the two colors
  81.      menu_cascade     A tile of an arrow of the
  82.                       foreground color
  83.      menu_checkmark   A tile of a checkmark of
  84.                       the foreground color
  85.      menu_dash        A tile of one horizontal
  86.                       line of the foreground
  87.                       color
  88.  
  89.      RRRREEEETTTTUUUURRRRNNNN
  90.           Returns True when successful; returns False if NULL _i_m_a_g_e,
  91.           NULL _i_m_a_g_e__n_a_m_e, or duplicate _i_m_a_g_e__n_a_m_e is used as a
  92.           parameter value.
  93.  
  94.      RRRREEEELLLLAAAATTTTEEEEDDDD
  95.           XXXXmmmmUUUUnnnniiiinnnnssssttttaaaallllllllIIIImmmmaaaaggggeeee(3), XXXXmmmmGGGGeeeettttPPPPiiiixxxxmmmmaaaapppp(3), and XXXXmmmmDDDDeeeessssttttrrrrooooyyyyPPPPiiiixxxxmmmmaaaapppp(3).
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.